Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ichorCNA 1.1 update patch #284

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

ichorCNA 1.1 update patch #284

wants to merge 3 commits into from

Conversation

Jwong684
Copy link
Member

Updated ichorcna to allow for more flexibility in reference wigs (though ended up being a moot change for grch37-noalt); updated reference workflow to include hg19-reddy_masked.

Note that chrY info is needed for ichorCNA to complete. In the case of grch37-noalt (with no chrY), added extra lines in the wig to denote 0 coverage for chrY.

Pull Request Checklists

Important: When opening a pull request, keep only the applicable checklist and delete all other sections.

Checklist for New Module

Required

  • I used the cookiecutter template and updated the placeholder rules.

  • The snakemake rules follow the design guidelines.

    • All references to the rules object (e.g. for input files) are wrapped with str().
  • Every rule in the module is either listed under localrules or has the threads and resources directives.

  • Input and output files are being symlinked into the CFG["inputs"] and CFG["outputs"] subdirectories, respectively.

  • I grouped the input symlinking rule to the next job that uses the input files.

  • I updated the final target rule (*_all) to include every output rule.

  • I explained important module design decisions in CHANGELOG.md.

  • I tested the module on real data for all supported seq_type values.

  • I updated the default.yaml configuration file to provide default values for each rule in the module snakefile.

  • I did not set any global wildcard constraints. Any/all wildcard constraints are set on a per-rule basis.

  • I ensured that all symbolic links are relative and self-contained (i.e. do not point outside of the repository).

  • I replaced every value that should (or might need to) be updated in the default configuration file with __UPDATE__.

  • I recursively searched for all comments containing TODO to ensure none were left. For example:

    grep -r TODO modules/<module_name>/1.0

If applicable

  • I added more granular output subdirectories.

  • I added rules to the reference_files workflow to generate any new reference files.

  • I added subdirectories with large intermediate files to the list of scratch_subdirectories in the default.yaml configuration file.

  • I updated the list of available wildcards for the input files in the default.yaml configuration file.

Checklist for Updated Module

Important! If you are updating the module version, ensure the previous version of the module is restored from master.
If you want to restore a deleted file or directory from the remote master, you can use git checkout origin/master path/to/file,
then a git commit will ensure that file is tracked on your branch again.
Example:

mv modules/strelka/1.1 modules/strelka/1.2
git checkout origin/master modules/strelka/1.1

…dated reference workflow to include grch37-noalt
Copy link
Member

@lkhilton lkhilton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just hoping for a little more documentation for the new custom features - otherwise looks good!

# must use gc wig file corresponding to same binSize (required)
ichorCNA_gcWig:
"1000000": "inst/extdata/gc_{genome_build}_1000kb.wig"
"500000": "inst/extdata/gc_{genome_build}_500kb.wig"
"50000": "inst/extdata/gc_{genome_build}_50kb.wig"
"10000": "inst/extdata/gc_{genome_build}_10kb.wig"
# relative to ichorCNA directory (in 00-inputs/ichorCNA/)
ichorCNA_gcWig_custom: # must create an empty one for each genome_build unless you have a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think part of the comment is cut off here?

@@ -24,19 +24,40 @@ lcr-modules:
ichorCNA_normalPanel:
"1000000": "inst/extdata/HD_ULP_PoN_{genome_build}_1Mb_median_normAutosome_median.rds"
"500000": "inst/extdata/HD_ULP_PoN_{genome_build}_500kb_median_normAutosome_median.rds"
# relative to ichorCNA directory (in 00-inputs/ichorCNA/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you provide some documentation about when/why someone might want to use custom normalPanel and gcWig files?

@Kdreval
Copy link
Collaborator

Kdreval commented Mar 16, 2024

@Jwong684 just checking if you have any updates for Laura's comments?

@Jwong684
Copy link
Member Author

Added requested documentation and a guide to creating a custom panel of normals - should be good now

@Kdreval
Copy link
Collaborator

Kdreval commented Jul 26, 2024

@lkhilton it doesn't let me merge this because of the requested changes - can you please approve if everything is OK so we can get this to master?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants